# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.DisplayVideo.V3.Model.CustomBiddingAlgorithm do
  @moduledoc """
  A single custom bidding algorithm.

  ## Attributes

  *   `advertiserId` (*type:* `String.t`, *default:* `nil`) - Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
  *   `customBiddingAlgorithmId` (*type:* `String.t`, *default:* `nil`) - Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
  *   `customBiddingAlgorithmType` (*type:* `String.t`, *default:* `nil`) - Required. Immutable. The type of custom bidding algorithm.
  *   `displayName` (*type:* `String.t`, *default:* `nil`) - Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
  *   `entityStatus` (*type:* `String.t`, *default:* `nil`) - Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
  *   `modelDetails` (*type:* `list(GoogleApi.DisplayVideo.V3.Model.CustomBiddingModelDetails.t)`, *default:* `nil`) - Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
  *   `name` (*type:* `String.t`, *default:* `nil`) - Output only. The resource name of the custom bidding algorithm.
  *   `partnerId` (*type:* `String.t`, *default:* `nil`) - Immutable. The unique ID of the partner that owns the custom bidding algorithm.
  *   `sharedAdvertiserIds` (*type:* `list(String.t)`, *default:* `nil`) - The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :advertiserId => String.t() | nil,
          :customBiddingAlgorithmId => String.t() | nil,
          :customBiddingAlgorithmType => String.t() | nil,
          :displayName => String.t() | nil,
          :entityStatus => String.t() | nil,
          :modelDetails =>
            list(GoogleApi.DisplayVideo.V3.Model.CustomBiddingModelDetails.t()) | nil,
          :name => String.t() | nil,
          :partnerId => String.t() | nil,
          :sharedAdvertiserIds => list(String.t()) | nil
        }

  field(:advertiserId)
  field(:customBiddingAlgorithmId)
  field(:customBiddingAlgorithmType)
  field(:displayName)
  field(:entityStatus)
  field(:modelDetails, as: GoogleApi.DisplayVideo.V3.Model.CustomBiddingModelDetails, type: :list)
  field(:name)
  field(:partnerId)
  field(:sharedAdvertiserIds, type: :list)
end

defimpl Poison.Decoder, for: GoogleApi.DisplayVideo.V3.Model.CustomBiddingAlgorithm do
  def decode(value, options) do
    GoogleApi.DisplayVideo.V3.Model.CustomBiddingAlgorithm.decode(value, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.DisplayVideo.V3.Model.CustomBiddingAlgorithm do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end
